/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
/**
 * Software License, Version 1.0
 *
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 *
 *
 *Redistribution and use in source and binary forms, with or without
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For
 * further information contact the Community Grids Lab at
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and
 * wherever such third-party acknowledgments normally appear.
 *
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering,
 * shall not be used to endorse or promote products derived from this software
 * without prior written permission from Indiana University.  For written
 * permission, please contact the Advanced Research and Technology Institute
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering,
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 *
 *
 * Indiana University provides no reassurances that the source code provided
 * does not infringe the patent or any other intellectual property rights of
 * any other entity.  Indiana University disclaims any liability to any
 * recipient for claims brought by any other entity based on infringement of
 * intellectual property rights or otherwise.
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS.
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS",
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.deployment.axis.wse.handler;

import java.util.StringTokenizer;

import javax.xml.soap.SOAPMessage;

import org.apache.axis.AxisFault;
import org.apache.axis.MessageContext;

import cgl.narada.wsinfra.WsMessageFlow;
import cgl.narada.wsinfra.deployment.axis.WsInfraAxisHandler;
import cgl.narada.wsinfra.deployment.axis.wse.WseServicesFactory;
import cgl.narada.wsinfra.exception.DeploymentException;
import cgl.narada.wsinfra.exception.IncorrectExchangeException;
import cgl.narada.wsinfra.exception.MessageFlowException;
import cgl.narada.wsinfra.exception.ParsingException;
import cgl.narada.wsinfra.exception.ProcessingException;
import cgl.narada.wsinfra.exception.UnknownExchangeException;
import cgl.narada.wsinfra.schemas.addressing.ActionDocument;
import cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType;
import cgl.narada.wsinfra.schemas.addressing.FromDocument;
import cgl.narada.wsinfra.schemas.addressing.ToDocument;
import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.util.SoapEnvelopeConversion;
import cgl.narada.wsinfra.wsa.AddressingHeaders;
import cgl.narada.wsinfra.wsa.ParseWsaHeaders;
import cgl.narada.wsinfra.wsa.WsaEprCreator;
import cgl.narada.wsinfra.wsa.WsaProcessingFactory;
import cgl.narada.wsinfra.wse.WseActions;
import cgl.narada.wsinfra.wse.WseNodeUtils;
import cgl.narada.wsinfra.wse.WseProcessingFactory;
import cgl.narada.wsinfra.wse.impl.WseSinkProcessor;

/**
 * @author Damodar Yemme
 * Created on Mar 15, 2005
 * This handler class will help Sink web services to create call to Source or
 * Subscription manager.
 */
public class WseSinkHandler
    extends WsInfraAxisHandler {
  private String moduleName = "WseSinkHandler";
  private WsaEprCreator eprCreator;
  private WseSinkProcessor wseSinkProcessor;
  private EndpointReferenceType sinkEpr;
  private WseNodeUtils wseNodeUtils;
  private String sinkAddress;
  private WseActions wseActions;
  private String handlerClassNames;
  private String methodName;
  /**
   * Constructor for WseSinkHandler
   * @throws DeploymentException
   */
  public WseSinkHandler() throws DeploymentException {
    sinkAddress = WseServicesFactory.getSinkAddress();
    eprCreator = WsaProcessingFactory.getWsaEprCreator();
    sinkEpr = eprCreator.createEpr(sinkAddress);
    wseSinkProcessor = WseSinkProcessor.getInstance();
    wseSinkProcessor.setMessageFlow(this);
    wseSinkProcessor.setSinkEPR(sinkEpr);
    wseActions = WseActions.getInstance();
    wseNodeUtils = WseProcessingFactory.getWseNodeUtils();
    handlerClassNames = WseServicesFactory.getHandlerChain();
    methodName = WseServicesFactory.getMethodName();
    this.initilizeInfraAxisHandler();
  }

  /**
   * This method will add Response handler chain
   * @param String classNames
   */
  private void addResponseHandlerChain(String classNames) {
    StringTokenizer classNameTokenizer
        = new StringTokenizer(classNames, ",");

    while (classNameTokenizer.hasMoreTokens()) {

      String className = classNameTokenizer.nextToken();
      System.out.println("handler name " + className);
      org.apache.axis.handlers.BasicHandler handler =
          (org.apache.axis.handlers.BasicHandler) createObject(className);
      this.addHandler(handler);

    }
  }

  /**
   * This method creates response handler chain class instance.
   * @param String classNames
   */
  private Object createObject(String className) {
    Object object = null;
    try {
      Class classDefinition = Class.forName(className);
      object = classDefinition.newInstance();
    }
    catch (Exception e) {
      System.out.println(e);
    }
    return object;
  }

  /**
   * This will be onvoked by AXIS Engine and must implement to modify Message.
   * @param MessageContext
   */
  public void invoke(MessageContext messageContext) throws AxisFault {
    try {

      SOAPMessage soapMessage
          = (SOAPMessage) messageContext.getCurrentMessage();
      SoapEnvelopeConversion soapEnvelopeConversion
          = SoapEnvelopeConversion.getInstance();
      EnvelopeDocument envelopeDocument
          = soapEnvelopeConversion.getEnvelopeDocument(soapMessage);

      setSoapActionURI(methodName);
      addResponseHandlerChain(handlerClassNames);

      String from = null;
      String to = null;
      ToDocument toDocument = null;
      FromDocument fromDocument = null;
      AddressingHeaders addressingHeaders = null;
      ParseWsaHeaders parseWsaHeaders
          = WsaProcessingFactory.getParseWsaHeaders();
      try {
        toDocument = parseWsaHeaders.getTo(envelopeDocument);
        fromDocument = parseWsaHeaders.getFrom(envelopeDocument);
        addressingHeaders
            = parseWsaHeaders.getAddressingHeaders(envelopeDocument);
      }
      catch (ParsingException parseEx) {
        /** Ignore this exception. */
        System.out.println("Problems parsing the envelope" +
                           parseEx.toString());
      }
      String action = null;
      ActionDocument actionDocument = null;
      try {
        actionDocument = addressingHeaders.getAction();
        if (actionDocument == null) {
          String reason = moduleName +
              "Action missing. Processor only deals with " +
              "WS-Eventing exchanges.";
        }

        if (actionDocument != null) {
          action = actionDocument.getAction().getStringValue();
        }
      }
      catch (Exception e) {
        System.out.println(moduleName +
                           "Exception in Processing action " + e);
      }
      System.out.println("\n*** actionType : " + action + "***\n");
      to = toDocument.getTo().getStringValue();
      initilizeInfraAxisHandler();
      if (to.equalsIgnoreCase(sinkAddress)) {
        System.out.println("*****Received SOAPMessage from Network***");
        processExchange(envelopeDocument, WsMessageFlow.FROM_NETWORK);
      }
      else {
        System.out.println("**Received SOAPMessage from Application**");
        processExchange(envelopeDocument, WsMessageFlow.FROM_APPLICATION);
      }
    }
    catch (UnknownExchangeException e) {
      System.out.println(moduleName + " UnknownExchangeException :  " + e);
    }
    catch (IncorrectExchangeException e) {
      System.out.println(moduleName + " IncorrectExchangeException " + e);
    }
    catch (MessageFlowException e) {
      System.out.println(moduleName + " MessageFlowException : " + e);
    }
    catch (Exception e) {
      System.out.println(moduleName + " Exception is " + e);
    }
  }

  /**
   * This method will Process Message coming from the network to Sink.
   * @param envelopeDocument
   * @throws IncorrectExchangeException
   * @throws ProcessingException
   * @throws MessageFlowException
   * @throws UnknownExchangeException
   */
  public void processExchange(EnvelopeDocument envelopeDocument,
                              int direction) throws IncorrectExchangeException,
      ProcessingException, MessageFlowException, UnknownExchangeException {
    if (direction == WsMessageFlow.FROM_NETWORK) {
      wseSinkProcessor.processExchange(
          envelopeDocument, WsMessageFlow.FROM_NETWORK);
    }
    if (direction == WsMessageFlow.FROM_APPLICATION) {
      boolean validate =
          wseSinkProcessor.processExchange(
          envelopeDocument, WsMessageFlow.FROM_APPLICATION);
      if (validate) {
        SOAPMessage soapMessage = getSOAPMessage(envelopeDocument);
        enrouteToNetwork(soapMessage);
      }
    }
  }

  /**
   * This method will return SOAPMessage from EnvelopeDocument
   * @param envelopeDocument
   * @return SOAPMessage
   */
  private SOAPMessage getSOAPMessage(EnvelopeDocument envelopeDocument) {
    SOAPMessage soapMessage = null;
    SoapEnvelopeConversion soapEnvelopeConversion = SoapEnvelopeConversion
        .getInstance();
    try {

      soapMessage = soapEnvelopeConversion
          .getSOAPMessage(envelopeDocument);
    }
    catch (ProcessingException ex) {
      String errorReport = "Problems converting to javax.xml.SOAPMessage\n"
          + ex.toString();
      System.out.println(errorReport);
    }
    return soapMessage;
  }
}